MarkLogic Server 11.0 Product Documentation
GET /manage/v2/certificates/{id|name}/propertiesSummary
This resource address returns the properties of the specified certificate.
| URL Parameters |
| format |
The format of the returned data. Can be either
json or xml (default). This value overrides the Accept header if
both are present. |
| Request Headers |
| Accept |
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header. |
| Response Headers |
| Content-type |
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
|
Response
Upon success, MarkLogic Server returns status code 200 (OK), and the response
body contains the requested data. A status code of 401 (Unauthorized) is returned if the user
does not have the necessary privileges. A status code of 404 (no such user) is returned if the
user does not exist.
Required Privileges
This operation requires one of the following:
- the
manage-admin and security role
- the following privileges:
http://marklogic.com/xdmp/privileges/manage
http://marklogic.com/xdmp/privileges/manage-admin
http://marklogic.com/xdmp/privileges/get-user
Usage Notes
The structure of the output returned from
this REST API is as follows:
version
The X509 version.
serialNumber
A serial number.
validity
The time span during which the certificate is valid.
This is a complex structure with the following children:
notBefore
The beginning of the period of time during which the certificate
is valid.
notAfter
The end of the period of time during which the certificate
is valid.
issuer
The issuer for a certificate.
This is a complex structure with the following children:
countryName
A two character country code (e.g. "US").
stateOrProvinceName
The state or province your server is in.
localityName
The city your server is in.
organizationName
The organization or company your server belongs to (e.g. MarkLogic).
organizationalUnitName
The organizational unit your server belongs to (e.g. Engineering).
emailAddress
The email address to contact regarding your server
(e.g. webmaster@yourcompany.com).
commonName
The common name of your server (e.g. www.yourcompany.com). This may be
left blank when creating a certificate template, since individual
servers will use their own host name.
subject
The subject for a certificate or certificate request. You should
fill in as many of these fields as possible because individual
certificate authorities have specific requirements for which fields
must have values. If a required field is missing, a certificate
authority will typically reject your certificate request with a
cryptic error message that your request is bad.
This is a complex structure with the following children:
countryName
A two character country code (e.g. "US").
stateOrProvinceName
The state or province your server is in.
localityName
The city your server is in.
organizationName
The organization or company your server belongs to (e.g. MarkLogic).
organizationalUnitName
The organizational unit your server belongs to (e.g. Engineering).
emailAddress
The email address to contact regarding your server
(e.g. webmaster@yourcompany.com).
commonName
The common name of your server (e.g. www.yourcompany.com). This may be
left blank when creating a certificate template, since individual
servers will use their own host name.
publicKey
The certificate's public key.
v3ext
The X509v3 extensions.
signatureType
The type of algorithm used to sign the certificate.
Example
http://localhost:8002/manage/v2/certificates/mycert/properties
==> Returns the properties of the certificate, "mycert,"
from the Security database.
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.